home *** CD-ROM | disk | FTP | other *** search
/ TPUG - Toronto PET Users Group / TPUG Users Group CD / TPUG Users Group CD.iso / AMIGA / AMICUS / AMICUS17.ADF / ATerm / Aterm7.2.doc < prev    next >
Text File  |  1989-01-27  |  18KB  |  380 lines
  1.  
  2.             Aterm Users Guide
  3.             -----------------
  4.  
  5. OVERVIEW:
  6.  
  7.   Aterm is a general purpose terminal program that incorporates the basic
  8. necessities, such as ASCII and protocol file transfer ability, as well as
  9. features to make life easier for the user.  Following is a list of the main
  10. features of Aterm:
  11.  
  12.     > Baud rates     - 300, 1200, 2400, 4800, 9600
  13.                   - initial rate set from Preferences.
  14.  
  15.     > File transfers - ASCII transmit/capture to any device.
  16.                Prompted transmit with user definable prompt.
  17.              - XMODEM (checksum)
  18.              - XMODEM (CRC)
  19.              - SuperKermit (Sliding Windows Kermit)
  20.  
  21.     > Duplex control - Full, Half, Echo.
  22.  
  23.     > Function keys  - User definable.
  24.              - May be saved/loaded along with other parameters.
  25.              - Function keys may be chained/loaded from key
  26.                defintion.
  27.              - Function key files may be in S: directory.
  28.              - Provision for default function key file.
  29.  
  30.     > Autochop     - Uses "hunk-end" padding during XMODEM send to
  31.                eliminate need for chopping at receiving end.
  32.              - Automatic pad stripping on XMODEM downloads.
  33.              - Properly pads/strips executable and ARCed files.
  34.  
  35.     > Flow control     - Xon/Xoff selectable (enabled/disabled)
  36.  
  37.     > CHAT mode     - A split screen mode that allows entry of one line
  38.                of text, which is sent as a "block" when a <RETURN>
  39.                is entered.  Prevents mixing of incoming/outgoing
  40.                lines when used in ICUGSIG CHAT on The Source. 
  41.                Minimizes line mixing on other networks.
  42.  
  43.     > Clock         - Clock runs in title bar if present in 
  44.                C: directory.
  45.                
  46.  
  47.                      *============================*
  48.  
  49. HARDWARE REQUIRED:
  50.  
  51.   Any RS232 modem that can be controlled with ASCII text strings, ie. Hayes or
  52. compatible. Please note that Aterm does not require any other RS232 lines than
  53. TXD, RXD, and SIGNAL GROUND.  No other lines (DSR, CTS, CD, etc.) are checked.
  54.  
  55.   You may have to set your modem DIP switches to simulate DTR being present.
  56.  
  57.  
  58.                      *============================*
  59.  
  60. INSTALLING ATERM:
  61.  
  62.   There are a few configurations that you may want to use, depending solely
  63. upon your personal preferences.
  64.  
  65.   1. Aterm, AtermClock, Init.Key, and any other function key files in CD
  66.      (current directory).
  67.  
  68.   2. Aterm in any other directory.
  69.      AtermClock in C: directory.
  70.      Init.Key and other FKey files in S: directory.
  71.  
  72.   3. Aterm and AtermClock in C: directory.
  73.      Init.Key and other FKey files in S: directory.
  74.  
  75.   If you use Aterm a lot, option 3 is the easiest way to go.  A brief
  76. explanation of the operation as applied to AtermClock and FKey files will serve
  77. to help you decide how to configure.
  78.  
  79.   When Aterm loads, it will attempt to load AtermClock, which runs as a
  80. separate task, from the current directory.  If it not present in the CD, Aterm
  81. will attempt to load it from the C: directory. (This is the 'c' directory on
  82. your boot disk if you have not used ASSIGN to change it)  If it is still not
  83. found, Aterm will decide that you did not want the clock, and will tell you it
  84. could not be found. Running without the clock in no way impacts Aterm's
  85. operation.
  86.  
  87.   Aterm then attempts to load a file called Init.Key from the current
  88. directory. If not found, it will try to load it from the S: directory.
  89. (The 's' directory on your boot disk if you have not used ASSIGN to change it)
  90. If it is not found, Aterm will set its own defaults, with the exception of the
  91. baud rate, which will take the value specified by your Preferences (from a file
  92. called 'system-configuration').
  93.  
  94.   I use the last option, but you may prefer to use one of the others. I have
  95. Aterm in my C: directory, with the name Aterm. While you can name Aterm
  96. anything you desire, AtermClock and Init.Key must be as specified, or they will
  97. not be found by Aterm.
  98.  
  99.                      *============================*
  100.  
  101.                   OPERATION
  102.  
  103. GETTING STARTED:
  104.  
  105. Invoke Aterm by the following methods... (assuming it is named Aterm)
  106.  
  107. If Aterm is in the C: directory or if it is in the current directory:
  108.  
  109. RUN Aterm
  110.  
  111. If it is in another directory... (assume it is in DF1: directory 'terminals')
  112.  
  113. RUN DF1:terminals/Aterm
  114.  
  115.  
  116.   NOTE: Capitals are optional.
  117.  
  118.   NOTE: The RUN is optional, but if used, greatly enhances the use of Aterm. It
  119.   will allow you to run other programs from the CLI, which may be seen by
  120.   simply clicking on the 'push to back' gadget on Aterm's screen. To return to
  121.   Aterm, click on the same gadget in the CLI screen. The CLI window may also be
  122.   left in front and resized. I often edit or print files, compile, or rearrange
  123.   disks while uploading or downloading. Unlike some commercial terminal
  124.   programs, Aterm does not make a pig of itself by hogging the printer port (or
  125.   any other system resources it isn't currently using).
  126.  
  127.   At this time, Aterm will load, then try to load the clock and default
  128. function key file, and you will see a title screen.  Provided your modem is
  129. hooked up and powered on, you may now start to use it.
  130.  
  131.   The only way to have an Init.Key file is to create one with Aterm. To do
  132. this, simply use the right (menu) button on the mouse to set up the parameters
  133. that you will want to use. The settable parameters are:
  134.  
  135.   Prompt - Settable from the 'File' menu.
  136.  
  137.   Baud - Select the baud rate from the 'Baud' menu if you want Aterm to come up
  138.          with a different setting than that specified in your Preferences.
  139.  
  140.   Mode - Half, Full, or Echo, settable from the 'Mode' menu.
  141.  
  142.   Autochop - On/Off, settable from the 'Miscellaneous' menu.
  143.  
  144.   Xon/Xoff - On/Off, settable from the 'Miscellaneous' menu.
  145.  
  146.   Protocol - XMODEM, XMODEM CRC, Kermit, from the 'Miscellaneous' menu.
  147.  
  148.   You may also wish to define some function keys at this time.
  149.  
  150.   When you have everything set to your satisfaction, select 'FKey Save' from
  151. the 'Miscellaneous' menu.  You will be prompted for the file name you wish to
  152. save the file under.  Type one of the following, ending your input with a
  153. <RETURN>.
  154.  
  155. Init.Key
  156.  
  157. S:Init.Key
  158.  
  159. DF1:terminal/Init.Key
  160.  
  161.  Depending on your preferred configuration as outlined above.
  162.  
  163.                      ----------------------------
  164.  
  165.   Next, a step by step tour of the items in the menus.
  166.  
  167.   Please note that any menu items followed by the <Amiga> symbol may be
  168.   selected by holding down the right <Amiga> key, and typing the key that is
  169.   shown immediately after the symbol in the menu. ie. <Right Amiga> C will 
  170.   initiate ASCII capture mode, or terminate it if it is already capturing.
  171.  
  172. File:
  173.  
  174.   ASCII Capture:  You will be asked for a file name. The file named will be
  175.   opened for writing, and anything appearing on your screen will be written to
  176.   the file. CTRL characters are for the most part suppressed so that the file
  177.   may be edited with ED. If no path is given, the file will be written to your
  178.   current directory. Good results are obtained by capturing to RAM:, but care
  179.   must be taken to ensure that you have enough memory to hold the data.
  180.     You may capture to RAM:, DF0:, DF1:, DH0: PRT:, or any other device that
  181.   may be added to the Amiga at a later date.
  182.     To end the ASCII capture, you simply select ASCII capture again.
  183.  
  184.   ASCII Transmit: You will be asked for a file name.  The file named will be
  185.   opened for reading, and the contents of the file will be sent out on the
  186.   modem port.  If no path is given, the file must be in the current directory.
  187.     The ASCII transmit will be terminated when the file has been sent in its
  188.   entirety, and may be terminated earlier by selecting ASCII Transmit again.
  189.  
  190.   Binary Receive: You will be asked for a file name. The file named will be
  191.   opened for writing, and as the file is received (using the protocol selected
  192.   in the 'Miscellaneous' menu), it will be written.  The file may contain any
  193.   sort of data, and it will not be changed in any way. As with ASCII Capture,
  194.   you may Receive to any device (except the printer).
  195.     To abort the transfer early, press the <ESC> key. The host may 'lock up' at
  196.   this time, but will usually respond to a few <RETURN>s, CTRL Zz, or CTRL Xs.
  197.  
  198.   Binary Transmit: You will be asked for a file name. The named file will be
  199.   opened for reading, and the contents of it will be sent unchanged to the host
  200.   or other terminal program via the protocol selected.  Please note that the
  201.   host or other terminal program must be using the same protocol as you are.
  202.     The protocol used is dependent upon the setting of the protocol selection
  203.   in the Miscellaneous menu.
  204.     The transfer may be aborted early by pressing the <ESC> key.
  205.  
  206.   Prompt: The prompt character is a user definable character that is used to
  207.   'pace' the ASCII Transmit operation.  If a 'full blast' transmission is
  208.   desired, simply type a '0' to set the prompt character to its "inactive"
  209.   state. To set it to any other character, press the key desired when asked to
  210.   supply a character. A common character to use is <RETURN>.  The operation of
  211.   the prompted ASCII Transmit is as follows... Aterm will transmit 1 line of
  212.   the file, then wait until it receives the prompt character from the modem.
  213.   When The prompt character is received, the next line will be sent.
  214.   This helps to ensure that the host or other terminal is ready to receive
  215.   more data.
  216.  
  217. Baud:
  218.  
  219.   Use the mouse to select any baud rate from 300 to 9600 baud.
  220.  
  221. Mode:
  222.  
  223.   Half:  Half duplex (not really duplex, but 'local echo', but who's being
  224.   picky?), will cause all characters sent to the modem to also be printed to
  225.   the screen. Use this setting if the host or other terminal does not echo
  226.   your own characters to you.
  227.  
  228.   Full:  Use when the host or other terminal echos your characters to you. All
  229.   characters you type will be sent to the modem only, and you are depending on
  230.   the other end to send them back so you can see them. Switch to this setting
  231.   if you are getting double characters, ie. HHeelllloo..
  232.  
  233.   Echo:  Sends any characters received from the modem back out to the modem.
  234.   Use this setting if you wish to echo characters to the other end. Be careful
  235.   with this one, as it has some strange side effects if enabled during up or
  236.   downloads, or whenever you are connected to a host or other terminal that
  237.   also echos your characters.
  238.  
  239. Miscellaneous:
  240.  
  241.   FKey Load:  You will be asked for a file name. This file will be used as a
  242.   function key definition and 'settings' file. The file MUST be one previously
  243.   generated by Aterm with the FKey Save function. As with Init.Key, it may
  244.   either be in the current directory or the S: directory. If it is in neither,
  245.   you will have to specify the complete path.
  246.  
  247.   FKey Save:  You will be asked for a file name. Your current function key
  248.   definitions and menu settings will be written to the named file. Please note
  249.   that if you want the file anywhere but the current directory, that you will
  250.   need to specify the path, ie. S:name or DF1:term/name.
  251.  
  252.   Define FKey: You will be asked for a function key string definition. This is
  253.   a string of characters that you wish to be sent when a function key is
  254.   pressed. First, you must tell Aterm which function key to define. This is
  255.   done by pressing the appropriate function key. You may only define the
  256.   function keys on the top row, and they are limited to 40 characters each.
  257.   There is a way to have a longer definition, as well as being able to define
  258.   more keys, but this will be covered in a later section. All characters are
  259.   legal in a function key definition, including all CTRL characters, <CR>,
  260.   <TAB>, <ESC>, etc.  To end the definition, press any function key.  The
  261.   reason for splitting the extra options in the definition is that they are
  262.   temporary 'quick and dirty' solutions, and will be changed in future
  263.   revisions to Aterm.
  264.  
  265.   Auto Chop:  Set this to 'ON' to download executable, ARCed and text files. 
  266.   Set to 'OFF" for 'problem files' that may have been uploaded with a program
  267.   that does not properly pad the end of the file. Files such as icons,
  268.   graphics, instrument, etc, may be chopped too short if they are autochopped.
  269.   In this case it it better to leave them unchopped and to attempt to chop them
  270.   to the right length offline.
  271.  
  272.   Xon/Xoff: Set this 'ON' for flow control. If you are sending to a host, it
  273.   will sometimes require you to wait while it is busy doing something else. To
  274.   signal that this is the case, it will send you an 'Xoff' ( CTRL S ), and when
  275.   it is ready for more data, it will send you an 'Xon' ( CTRL Q ). Sometimes,
  276.   however, especially when dealing with a packet switching network, certain 
  277.   conditions may cause the network to send an 'Xoff', without a corresponding
  278.   'Xon'. This will lock up the terminal program, and will mean that to recover,
  279.   you will have to reboot the Amiga <CTRL-Amiga-Amiga>, to recover. Line noise
  280.   may also send you an unintentional CTRL S. In these cases, select 'OFF' for
  281.   this option.
  282.  
  283.   Protocol:
  284.  
  285.     XModem:  This is the 'plain' checksum Xmodem, as supported by The Source.
  286.  
  287.     Xmodem CRC:  This is a better XModem protocol, with better error checking.
  288.     If you select this option, and the other side does not support it, there
  289.     will be a delay, then both sides will go back to the 'plain' XModem. To
  290.     avoid this delay, set Xmodem to match the other side.
  291.  
  292.     Kermit:  This is an implementation of Sliding Windows Kermit, and is
  293.     superior in speed and error checking to XModem, especially over packet
  294.     switching networks. When a file transfer is started, both ends will
  295.     "negotiate for parameters", using the best of the Kermit protocols that
  296.     both ends can handle. Thus, this implementation may interact with any
  297.     lesser versions, using the best parameters that the lesser version can 
  298.     handle.  The authors would appreciate hearing about any compatibility
  299.     problems encountered with lesser versions.
  300.  
  301.   CHAT Mode: This gives you a 'split screen', a window along the bottom of the
  302.   screen that you can type a line of text into. The text you type is held in a
  303.   buffer and will only be sent when you end the line with a <RETURN>. While the
  304.   line is being typed, the upper part of the screen will still show any
  305.   characters arriving from the modem port.  While the line is being sent, no
  306.   characters arriving from the modem will be printed. This does wonders for the
  307.   readability of the screen while participating in ICUGSIG CHAT, especially if
  308.   you set TERM -HALF at the command level ( -> ).  When connected to another
  309.   terminal, and you are chatting, the worst that can happen is that your line
  310.   interrupts the other line only once, instead of having your characters and
  311.   those from the other side mixed randomly throughout the line.
  312.  
  313.                      *============================*
  314.  
  315.                    ADDENDUM
  316.  
  317. FKEY OPTIONS:
  318.  
  319.   In addition to the standard characters allowed in function keys, there are a
  320. few special keys that will, when the function key is sent, perform some special
  321. tasks. These are designed to extend the function keys, making them for all
  322. practical purposes, of unlimited length, and giving you the ability to change
  323. your key definitions automatically as you move from area to area within a
  324. network or bulletin board. 
  325.  
  326.   NOTE: The method used to implement these special functions is temporary,
  327.   constituting a 'quick and dirty' solution.  The authors would be glad to hear
  328.   from Aterm users about any ideas on implementation of this feature.
  329.  
  330.   The special options are <Fn:>, <LOAD>, and <LOADEX>. 
  331.  
  332.   In all cases, these must be the last thing defined as part of a function key
  333. definition (you'll see why in a moment). They are activated as follows.
  334.  
  335.   Select 'Define FKey' from the menu (or use the <right Amiga>D ).
  336.   Press the function key to be defined.
  337.   Enter whatever text you want sent to the modem prior to the execution of the
  338.    special command.
  339.   Press the <DEL> key.
  340.   Now press one of...
  341.      Any number key (1-0)
  342.      The 'l' key (lower case L)
  343.      The 'L' key (upper case l)
  344.  
  345.   The visual indication of these will be (in the same order)...
  346.      <Fn:>  (where n is the number pressed)
  347.      <LOAD> 
  348.      <LOADEX>
  349.  
  350.   The meanings and additional information to be supplied for each 
  351.   function are:
  352.   
  353.   <Fn:> - This will cause the currently defined function key specified by 'n' to
  354.   be sent/executed. '0' specifies FKey 10.
  355.  
  356.   <LOAD> - This one MUST be followed by the name of a file that contains a
  357.   function key definition. Upon executing the this command, Aterm will attempt
  358.   to load this file as a function key definition.  Handy for 'switching the
  359.   context' of your function keys when going to a different section of a
  360.   network or BBS.
  361.  
  362.   <LOADEX> - MUST be followed by a single digit (1-0), then immediately by a
  363.   file name. The file named must be a function key definition file. Aterm will
  364.   attempt to load this file as a function key definition file, and if loaded,
  365.   will then execute the newly defined key specified by the number immediately
  366.   after the <LOADEX> symbol.
  367.  
  368.   NOTE: If you wish to include a real <DEL> character in a function key
  369.   defintiton, just press the <DEL> key twice.
  370.  
  371.   The best way to find out about the uses for these functions is to play with
  372. them.
  373.  
  374.                      *============================*
  375.  
  376. Aterm Documentation file (C) November 1986 by Larry Phillips, ICUG.
  377.  
  378.  
  379.  
  380.